/**
 * Copyright (c) 2009 Teoti Graphix, LLC See:
 *     http://tkarchitecture.teotigraphix.org
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * @author Michael Schmalle mschmalle@teotigraphix.com
 */
package org.teotigraphix.dx.interfaces
{

/**
 * The <code>IModelLayer</code> interface is used in an 
 * <code>IModelLayerAware</code> component to register, remove, test and 
 * return <code>IModelLayer</code> models.
 * 
 * @copyright Teoti Graphix, LLC
 * @author Michael Schmalle
 * @date 07-07-09
 */
public interface IModelLayer
	   extends IComponentLayer
{
	//--------------------------------------------------------------------------
	//
	//  Methods
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Registers an <code>IComponentModel</code> to the model layer.
	 * 
	 * @param api A <code>Class</code> api used as the key for the 
	 * <code>IComponentModel</code> model instance.
	 * @param model An <code>IComponentModel</code> to register with the model layer.
	 */
	function registerModel(api:Class, model:IComponentModel):void
	
	/**
	 * Removes an <code>IComponentModel</code> from the model layer.
	 * 
	 * @param api A <code>Class</code> api used as the key for the 
	 * <code>IComponentModel</code> model instance.
	 * @return The removed <code>IComponentModel</code>.
	 */
	function removeModel(api:Class):IComponentModel;
	
	/**
	 * Tests for an <code>IComponentModel</code> registered with the model layer
	 * using a <code>Class</code> api key.
	 * 
	 * @param api A <code>Class</code> api used as the key for the 
	 * <code>IComponentModel</code> model instance.
	 * @return A boolean indicating whether the <code>IComponentModel</code>
	 * is contained in this layer.
	 */
	function hasModel(api:Class):Boolean;
	
	/**
	 * Returns an <code>IComponentModel</code> registered with the model layer
	 * using the registered models's <code>Class</code> api key.
	 * 
	 * @param api A <code>Class</code> api used as the key for the 
	 * <code>IComponentModel</code> model instance.
	 * @return The <code>IComponentModel</code> by <code>Class</code> api.
	 */
	function getModel(api:Class):IComponentModel;
	
	/**
	 * Returns an array of <code>IComponentModel</code>'s currently registered
	 * with this layer.
	 * @return All <code>IComponentModel</code>'s in this layer.
	 */
	function getModels():Array;	
}
}